home *** CD-ROM | disk | FTP | other *** search
/ World of Video / World of Video.iso / gfxprograms / conversion / rawaga / rawaga.doc < prev    next >
Text File  |  1995-02-13  |  12KB  |  344 lines
  1.  
  2.  
  3.                         "RawAGA" documentation
  4.  
  5.                              by Team HOI!
  6.  
  7.                              Version 2.0
  8.  
  9.  
  10.  
  11. FIRST NOTE...
  12.  
  13. This program will only work under kickstart 3.0 (V39) and higher. If you
  14. try to run this program under a lower kickstart version, the program won't
  15. work at all. Note that this version of RawAGA doesn't use any 68010+
  16. instructions, because there might be AGA computers with a 68000 processor
  17. in the future (who knows...?).
  18.  
  19.  
  20. IN GENERAL...
  21.  
  22. This utility enables you to convert graphics from the Interchange File
  23. Format (better known as IFF) to plain, raw data. The raw format is useful
  24. if you want to use graphics in your own productions. RawAGA is also useful
  25. if you want to convert your pictures into sprite data. Note that this
  26. converter can be used for non-AGA pictures as well. A note to the old Amiga
  27. crowd: follow your fellow freaks and upgrade to an AGA machine!
  28.  
  29. Why bother with a raw format if we've got the highly compressed IFF format?
  30. To be accurate: if you're not into programming, this utility means shit to
  31. you. Just keep using your ol' file formats. However, if you're into
  32. programming this utility can prove to be extremely useful to you. If you
  33. want to display a picture with the computer you HAVE to present the graphic
  34. data to the computer in a raw format (i.e. uncrunched). The same goes for
  35. sprites and Blitter OBjects.
  36.  
  37.  
  38. FEATURES: RawAGA...
  39.  
  40.      - handles all types of IFF pictures;
  41.  
  42.      - handles (anim)brushes;
  43.  
  44.      - handles Anim-5 animations;
  45.  
  46.      - is compatible with V39 and AGA Amigas;
  47.  
  48.      - converts while loading (for low memory situations);
  49.  
  50.      - converts AGA pictures as well as old picture types;
  51.  
  52.      - includes a frame cut/save option;
  53.  
  54.      - saves as either aligned (interleaved) or normal raw format;
  55.  
  56.      - can generate sprite data (2 and 4 bitplanes (attached));
  57.  
  58.      - can generate the special AGA sprites (32 and 64 pixels wide!);
  59.  
  60.      - can generate a colormap which is ready to use for a copperlist;
  61.  
  62.      - can generate a colormap for use with the LoadRGB32() function.
  63.  
  64.  
  65. INSTALLATION...
  66.  
  67. Drag RawAGA's icon into your favourite utilities drawer on your System
  68. partition or floppy. Double click on the icon and the program should run.
  69.  
  70. MAKE SURE THAT THE REQTOOLS.LIBRARY IS PRESENT IN YOUR LIBS DIRECTORY,
  71. OTHERWISE THE PROGRAM WILL FAIL TO WORK. THIS LIBRARY IS AVAILABLE AT YOUR
  72. LOCAL PUBLIC DOMAIN DISTRIBUTOR AND/OR BULLETIN BOARD SYSTEM.
  73.  
  74.  
  75. USAGE...
  76.  
  77. Start the program by double-clicking on the icon or by entering its name
  78. from the shell. If everything goes well, you're confronted with your
  79. workscreen. Select "Load" from the menu and a file-requester will appear.
  80. Select the IFF picture you wish to load. When the picture is loaded you can
  81. save the entire picture as a raw picture or as an interleaved picture. The
  82. difference between the two is as follows:
  83.  
  84. Suppose you have loaded a picture which is 200 lines high and 3 bitplanes
  85. deep...
  86.  
  87.      rawfile:  line1   bitplane1
  88.                line2   bitplane1
  89.                line3   bitplane1
  90.                ...
  91.                line200 bitplane1
  92.                line1   bitplane2
  93.                line2   bitplane2
  94.                line3   bitplane2
  95.                ...
  96.                line200 bitplane2
  97.                line1   bitplane3
  98.                line2   bitplane3
  99.                line3   bitplane3
  100.                ...
  101.                line200 bitplane3
  102.  
  103.  
  104. aligned file:  line1   bitplane1
  105.                line1   bitplane2
  106.                line1   bitplane3
  107.                line2   bitplane1
  108.                line2   bitplane2
  109.                line2   bitplane3
  110.                ...
  111.                line200 bitplane1
  112.                line200 bitplane2
  113.                line200 bitplane3
  114.  
  115. Note that RawAGA won't save a colormap behind the pictures because it has a
  116. separate option to do so.
  117.  
  118. If you don't want to convert the entire picture you can choose to cut a
  119. frame from the picture and save this. This frame can of course also be
  120. saved in either raw or aligned format.
  121.  
  122.  
  123. SPRITES...
  124.  
  125. If you want to cut a sprite out of the picture you have to keep these two
  126. things in mind:
  127.  
  128. 1: Is the picture either 2 or 4 bitplanes deep? If not you're not able to
  129. save sprite data (Sprites are always 2 or 4 bitplanes deep!).
  130.  
  131. 2: Is the frame you've cut either 16, 32 or 64 pixels wide? If not you
  132. won't be able to save sprite data (due to sprite hardware restrictions).
  133.  
  134.  
  135. If you have cut a frame which doesn't conflict with these two rules, you
  136. can select either to save the sprite as a source file or as a binary data
  137. file. The two are fully compatible with each other. If you would assemble
  138. the generated source file you'd get the same as the data file!
  139.  
  140. If you've selected a frame in a picture with a depth of four bitplanes, two
  141. files will automatically be saved. The first file will have the extension
  142. ".ATT1" and the other the extension ".ATT2". Obviously the first file will
  143. contain the information for sprite 1 and the second file the information
  144. for sprite 2.
  145.  
  146. The sprite data will be saved in the following format:
  147.  
  148. 2 bitplanes sprite, 16 wide:
  149.  
  150.  dc.w 0,0
  151.  dc.w line1_bitp1,line1_bitp2 
  152.  dc.w line2_bitp1,line2_bitp2
  153.  dc.w line3_bitp1,line3_bitp2
  154.  dc.w ...
  155.  
  156. 2 bitplanes sprite, 32 wide:
  157.  
  158.  dc.w 0,0,0,0
  159.  dc.w l1_word1_bitp1,l1_word2_bitp1,l1_word1_bitp2,l1_word2_bitp2
  160.  dc.w l2_word1_bitp1,l2_word2_bitp1,l2_word1_bitp2,l2_word2_bitp2
  161.  dc.w l3_word1_bitp1,l3_word2_bitp1,l3_word1_bitp2,l3_word2_bitp2
  162.  dc.w ...
  163.  
  164. 2 bitplanes sprite, 64 wide:
  165.  
  166.  dc.w 0,0,0,0,0,0,0,0
  167.  dc.w l1_w1_b1,l1_w2_b1,l1_w3_b1,l1_w4_b1,l1_w1_b2,l1_w2_b2,l1_w3_b2,l1_w4_b2
  168.  dc.w l2_w1_b1,l2_w2_b1,l2_w3_b1,l2_w4_b1,l2_w1_b2,l2_w2_b2,l2_w3_b2,l2_w4_b2
  169.  dc.w l3_w1_b1,l3_w2_b1,l3_w3_b1,l3_w4_b1,l3_w1_b2,l3_w2_b2,l3_w3_b2,l3_w4_b2
  170.  
  171. As mentioned before, In case of attached sprites (4 bitplanes), two files
  172. are saved with the information for sprite 1 (bitplanes 1 & 2) and for
  173. sprite 2 (bitplanes 3 & 4).
  174.  
  175.  
  176. ANIMS & BRUSHES...
  177.  
  178. If you load an anim file, a requester will appear on your screen. You can
  179. either select to load the first frame or the entire animation. To cycle
  180. through the animation, press (or hold down) the right cursor key. All of
  181. the functions in the menu work with anims as well.
  182.  
  183. In case of a brush, RawAGA loads the brush and makes sure that a screen
  184. which is sufficiently bigger is opened (enabling the menu to keep operating
  185. properly). If an animbrush is selected, RawAGA gives you the same requester
  186. you get when loading an animation. You can either read the first frame of
  187. the brush or load the entire animbrush in memory. Again you can press (or
  188. hold down) the right cursor key to advance through the frames.
  189.  
  190.  
  191. COLORMAPS...
  192.  
  193. RawAGA can save your colormap information in two ways, as a standard AGA
  194. copperlist or as a colorlist you can directly feed to the LoadRGB32 system
  195. function (Graphics base offset -882 (V39)). The save routine always saves
  196. these colormap files as a source file which is compatible with any decent
  197. assembler (like Asm-One, Seka, Devpac etcetera). The file format of these
  198. files is as follows...
  199.  
  200. Copperlistdata:
  201.      dc.w $0106,$0c40    ;colorbank select etc. (see AGA hardware facts)
  202.      dc.w $0180,$0xxx    ;high nibbles color0
  203.      dc.w $0182,$0xxx    ;high nibbles color1
  204.      dc.w ...
  205.      dc.w $01be,$0xxx    ;high nibbles color31
  206.      dc.w $0106,$0e40    ;loct bit on (selects high or low nibbles)
  207.      dc.w $0180,$0xxx    ;low nibbles color0
  208.      dc.w $0182,$0xxx    ;low nibbles color1
  209.      dc.w ...
  210.      dc.w $01be,$0xxx    ;low nibbles color31
  211.      dc.w $0106,$2c40    ;bank 1 select, loct bit off
  212.      dc.w $0180,$0xxx    ;high nibbles color32
  213.      dc.w $0182,$0xxx    ;high nibbles color33
  214.      dc.w ...
  215.      dc.w ...
  216.      dc.w ...
  217.      dc.w $0106,$ee40    ;bank 8 select, loct bit on
  218.      dc.w $0180,$0xxx    ;low nibbles color 224
  219.      dc.w $0180,$0xxx    ;low nibbles color 225
  220.      dc.w ...
  221.      dc.w $01be,$0xxx    ;low nibbles color 255
  222.  
  223. NOTE THAT THIS COLORMAP IS ALWAYS THE FULL 256 ENTRYS, EVEN IF YOU LOAD A
  224. PICTURE WITH LESS THEN 8 BITPLANES!
  225.  
  226. and the colormap data for the LoadRGB32 function is as follows:
  227.  
  228.      dc.w numberofentrys,0
  229.      dc.l $RR000000,$GG000000,$BB000000 ;RGB value for color 0
  230.      dc.l $RR000000,$GG000000,$BB000000 ;RGB value for color 1
  231.      dc.l ....
  232.      dc.l $RR000000,$GG000000,$BB000000 ;RGB value for the last color
  233.  
  234.  
  235. QUITTING...
  236.  
  237. Just select the "Quit" option from the menu or press the shortcut keys
  238. (left Amiga key and "Q").
  239.  
  240.  
  241. AGA HARDWARE FACTS/TIPS...
  242.  
  243. If you want to use the special AGA sprite modes, these registers are
  244. essential:
  245.  
  246.      FMODE ($dff1fc):
  247.           BIT 2 and 3 can make these combinations:
  248.                %00 = sprites are 16 bits wide and must be word aligned
  249.                %01 = sprites are 32 bits wide and must be longword aligned
  250.                %11 = sprites are 64 bits wide and must be quadword aligned
  251.  
  252.      BPLCON3 ($dff106):
  253.           BIT 6 and 7 can make these combinations:
  254.                %00 = sprites are ECS Default
  255.                %01 = sprites are LoRes (140 nS)
  256.                %10 = sprites are HiRes (70 nS)
  257.                %11 = sprites are SHRes (35 nS) (Super Hi-Res)
  258.           (these modes are independent of the screen resolution)
  259.  
  260.           BIT 13-15 can make 8 possible combinations selecting the
  261.           colorbank for the colorregisters ($0180-$1be).
  262.  
  263.  
  264. There are plenty more registers which have got something to do with sprites
  265. and/or colors but that would exceed the purpose of this documentation. It
  266. just helps you to get started!
  267.  
  268.  
  269. THE AUTHORS...
  270.  
  271. RawAGA was programmed by THAIZER and RhInO (Thijs van Rijswijk & Reinier
  272. van Vliet), both members of Team Hoi! You can reach us at the Total
  273. Confusion BBS in The Netherlands. The telephone number is:
  274. +31-(0)35-855918. Our handles are respectively THAIZER & RhInO. Please
  275. leave bug reports and comments whenever you like!
  276.  
  277.  
  278. COPYRIGHT & REGISTERING...
  279.  
  280. These programs are Copyrighted in 1993 by Team Hoi! The programs may be
  281. freely distributed if they are left unaltered. Please note that if the
  282. framecut options don't work, you've got an unregistered version! To
  283. register send 10 american dollars to bankaccountnr: 3917.18.509 in holland.
  284. Don't forget to state your full name and adres on the banktransfernote so
  285. we can send you the correct version.
  286.  
  287.  
  288. DISCLAIMER...
  289.  
  290. We (Team Hoi or any of the individual authors) are in no way responsible or
  291. liable for loss of data, or any other kind of information, due to
  292. (im)proper use of the program RawAGA.
  293.  
  294.  
  295. HISTORY...
  296.  
  297. 10-AUG-93> RawAGA V2.0
  298.  
  299. Added features:
  300.  
  301. - RawAGA now decodes while loading. This leaves more memory for
  302. multitasking than if you load the picture in memory first.
  303.  
  304. - RawAGA now handles animations correctly.
  305.  
  306. - RawAGA now handles brushes correctly and opens a bigger screen when
  307. necessary.
  308.  
  309. - RawAGA now handles animbrushes (animbrushes use a different format than
  310. normal anim files. They use the so-called "eor" technique).
  311.  
  312. - RawAGA now uses the v39 doublebuffer-tag when it has to play an
  313. animation.
  314.  
  315. - RawAGA can now save LoadRGB32 colormapdata
  316.  
  317. - RawAGA can now cut frames and save them as raw/aligned
  318.  
  319. - RawAGA can now cut sprites (normal sprites and AGA sprites)
  320.  
  321.  
  322. 10-APR-93> AGA Converter (old name)
  323.  
  324. - First version of the program
  325.  
  326.  
  327. AND FINALLY...
  328.  
  329. Do you already own Team Hoi's A.G.A. specific products, like the two
  330. HoisAGA demos ("Planet Groove" and "Mindwarp") and the "Enigma" encoding
  331. tool...? Look forward to the world's first (we hope) REAL A.G.A. game
  332. called Moon Child, the official sequel to our Amiga action game "Hoi!"
  333.  
  334. Please feel free to send your Team Hoi fanmail (no programme-technical
  335. stuff, just nice correspondence) to:
  336.  
  337. Metin Seven (Team Hoi's graphic artist and writer)
  338. Albrechtlaan 14
  339. 1404 AK  Bussum
  340. The Netherlands
  341.  
  342.  
  343. C YA !!!
  344.